
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta charset="utf-8"></meta>
		<meta name="generator" content="JsDoc Toolkit"></meta>
		<title>_global_ | Antville&#32;1.4&#32;API&#32;Reference</title>

		<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0;"></meta>
		<meta name="mobileoptimized" content="0"></meta>
	
		<link rel="stylesheet" href="../css/all.css" media="all"></link>
		<link rel="stylesheet" href="../css/handheld.css" media="only screen and (max-width: 660px)"></link>
		<link rel="stylesheet" href="../css/handheld.css" media="handheld"></link>
		<link rel="stylesheet" href="../css/screen.css" media="screen and (min-width: 661px)"></link>

		<script src="../javascript/all.js"></script>
		<!--[if lt IE 9]>
			<script src="../javascript/html5.js"></script>
		<![endif]-->
	</head>

	<body>

<div class="index">
	<div class="menu">
		<div class="indexLinks">
			<a href="../index.html">Classes</a>
			<a href="../files.html">Files</a>
		</div>
	
		<h2 class="heading1">Classes</h2>
		
		<input type="text" name="classFilter" class="classFilter" id="ClassFilter" placeholder="Filter"></input>
		
		<nav>
			<ul class="classList" id="ClassList">
				
					<li><a href="../symbols/_global_.html">_global_</a></li>
				
					<li><a href="../symbols/Admin.html">Admin</a></li>
				
					<li><a href="../symbols/Admin.Job.html">Admin<span class='break'> </span>.<span class='break'> </span>Job</a></li>
				
					<li><a href="../symbols/Api.html">Api</a></li>
				
					<li><a href="../symbols/Api.blogger.html">Api<span class='break'> </span>.<span class='break'> </span>blogger</a></li>
				
					<li><a href="../symbols/Api.metaWeblog.html">Api<span class='break'> </span>.<span class='break'> </span>metaWeblog</a></li>
				
					<li><a href="../symbols/Api.mt.html">Api<span class='break'> </span>.<span class='break'> </span>mt</a></li>
				
					<li><a href="../symbols/app.data.html">app<span class='break'> </span>.<span class='break'> </span>data</a></li>
				
					<li><a href="../symbols/Archive.html">Archive</a></li>
				
					<li><a href="../symbols/Choice.html">Choice</a></li>
				
					<li><a href="../symbols/Comment.html">Comment</a></li>
				
					<li><a href="../symbols/console.html">console</a></li>
				
					<li><a href="../symbols/Exporter.html">Exporter</a></li>
				
					<li><a href="../symbols/Feature.html">Feature</a></li>
				
					<li><a href="../symbols/File.html">File</a></li>
				
					<li><a href="../symbols/Files.html">Files</a></li>
				
					<li><a href="../symbols/helma.File.html">helma<span class='break'> </span>.<span class='break'> </span>File</a></li>
				
					<li><a href="../symbols/helma.Mail.html">helma<span class='break'> </span>.<span class='break'> </span>Mail</a></li>
				
					<li><a href="../symbols/HopObject.html">HopObject</a></li>
				
					<li><a href="../symbols/Image.html">Image</a></li>
				
					<li><a href="../symbols/Images.html">Images</a></li>
				
					<li><a href="../symbols/Images.Default.html">Images<span class='break'> </span>.<span class='break'> </span>Default</a></li>
				
					<li><a href="../symbols/Importer.html">Importer</a></li>
				
					<li><a href="../symbols/jala.i18n.html">jala<span class='break'> </span>.<span class='break'> </span>i18n</a></li>
				
					<li><a href="../symbols/JSON.html">JSON</a></li>
				
					<li><a href="../symbols/Layout.html">Layout</a></li>
				
					<li><a href="../symbols/LogEntry.html">LogEntry</a></li>
				
					<li><a href="../symbols/Members.html">Members</a></li>
				
					<li><a href="../symbols/Membership.html">Membership</a></li>
				
					<li><a href="../symbols/Metadata.html">Metadata</a></li>
				
					<li><a href="../symbols/Poll.html">Poll</a></li>
				
					<li><a href="../symbols/Polls.html">Polls</a></li>
				
					<li><a href="../symbols/Root.html">Root</a></li>
				
					<li><a href="../symbols/Site.html">Site</a></li>
				
					<li><a href="../symbols/Skin.html">Skin</a></li>
				
					<li><a href="../symbols/Skins.html">Skins</a></li>
				
					<li><a href="../symbols/Sql.html">Sql</a></li>
				
					<li><a href="../symbols/Stories.html">Stories</a></li>
				
					<li><a href="../symbols/Story.html">Story</a></li>
				
					<li><a href="../symbols/Tag.html">Tag</a></li>
				
					<li><a href="../symbols/TagHub.html">TagHub</a></li>
				
					<li><a href="../symbols/Tags.html">Tags</a></li>
				
					<li><a href="../symbols/User.html">User</a></li>
				
					<li><a href="../symbols/Vote.html">Vote</a></li>
				
			</ul>
		</nav>
	</div>
	<div class="fineprint" style="clear:both">
		
		Documentation generator: <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.4.0<br />
		Template: <a href="http://www.thebrightlines.com/2010/05/06/new-template-for-jsdoctoolkit-codeview/" target="_blank">Codeview</a> 1.2<br />
		Generated on: 2012-4-22 10:17
	</div>
</div>

<div class="index indexStatic"></div>

<div class="content">
	<div class="innerContent">
		<h1 class="classTitle">
			
			Built-In Namespace <span>_global_</span>
		</h1>
		
		<div class="intro">
			<p class="description summary">
				
			</p>
				
			
		</div>
		
		
		
		
			
			
				<div class="props">
					<table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class _global_.">
						<caption class="sectionTitle">Field Summary</caption>
						
						<thead>
							<tr>
								<th scope="col">Field Attributes</th>
								<th scope="col">Field Name and Description</th>
							</tr>
						</thead>
						
						<tbody>
							
								<tr>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont">
										<b><a href="../symbols/_global_.html#html">html</a></b>
										</div>
										<div class="description">An instance of Helma’s HTML rendering module.</div>
									</td>
								</tr>
							
								<tr>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont">
										<b><a href="../symbols/_global_.html#lessParser">lessParser</a></b>
										</div>
										<div class="description">An instance of the LESS parser.</div>
									</td>
								</tr>
							
								<tr>
									<td class="attributes">&lt;constant&gt; &nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont">
										<b><a href="../symbols/_global_.html#NAMEPATTERN">NAMEPATTERN</a></b>
										</div>
										<div class="description">Regular Expression according to Jala’s HopObject.getAccessName().</div>
									</td>
								</tr>
							
								<tr>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont">
										<b><a href="../symbols/_global_.html#rome">rome</a></b>
										</div>
										<div class="description">A collection of Java classes and namespaces required for parsing and generating RSS.</div>
									</td>
								</tr>
							
								<tr>
									<td class="attributes">&lt;constant&gt; &nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont">
										<b><a href="../symbols/_global_.html#SQLDATEFORMAT">SQLDATEFORMAT</a></b>
										</div>
										<div class="description">The date format used in SQL queries and commands.</div>
									</td>
								</tr>
							
						</tbody>
					</table>
				</div>
			
			
			
		
<!--
#### METHODS SUMMARY
-->
		
			
			
			<div class="props">
				<h2 class="sectionTitle">Method Summary</h2>
				
				
					<table class="summaryTable" id="MethodsList" cellspacing="0" summary="A summary of the methods documented in the class _global_.">
						<thead>
							<tr>
								<th scope="col">Method Attributes</th>
								<th scope="col">Method Name and Description</th>
							</tr>
						</thead>
						
						<tbody>
							
							
								<tr
									 class='item0'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#age_filter">age_filter</a></b>(value, param)
										</div>
										<div class="description">Helma macro filter wrapping the Date#getAge method.</div>
									</td>
								</tr>
							
								<tr
									 class='item1'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#breadcrumbs_macro">breadcrumbs_macro</a></b>(param, delimiter)
										</div>
										<div class="description">Renders a breadcrumbs navigation from the current HopObject path.</div>
									</td>
								</tr>
							
								<tr
									 class='item2'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#cgettext">cgettext</a></b>(key, context)
										</div>
										<div class="description">This method is useful for disambiguation of messages (single words most of the time) that have different meanings depending on the context.</div>
									</td>
								</tr>
							
								<tr
									 class='item3'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#clip_filter">clip_filter</a></b>(input, param, limit, clipping, delimiter)
										</div>
										<div class="description">Macro filter for clipping output.</div>
									</td>
								</tr>
							
								<tr
									 class='item4'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#default_filter">default_filter</a></b>(value, param, defaultValue)
										</div>
										<div class="description">A simple Helma macro filter returning one of two possible values depending on which one is truthy.</div>
									</td>
								</tr>
							
								<tr
									 class='item5'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#defineConstants">defineConstants</a></b>(ctor)
										</div>
										<div class="description">Helper method to simultaneously define constants and a corresponding array of localized display names.</div>
									</td>
								</tr>
							
								<tr
									 class='item6'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#disableMacro">disableMacro</a></b>(ctor, name)
										</div>
										<div class="description">Disables a macro with the idle() function.</div>
									</td>
								</tr>
							
								<tr
									 class='item7'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#file_macro">file_macro</a></b>(param, id, mode)
										</div>
										<div class="description">Renders the URL or an arbitrary skin of a file.</div>
									</td>
								</tr>
							
								<tr
									 class='item8'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#fixRssText">fixRssText</a></b>(rss)
										</div>
										<div class="description">Replaces <img> elements in a string with <a> elements to fix RSS output which is not capable of displaying images.</div>
									</td>
								</tr>
							
								<tr
									 class='item9'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#format_filter">format_filter</a></b>(value, param, pattern, type)
										</div>
										<div class="description">Helma macro filter wrapping the global formatting methods.</div>
									</td>
								</tr>
							
								<tr
									 class='item10'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#formatDate">formatDate</a></b>(date, format)
										</div>
										<div class="description">Formats a date according to a formatting string and the site’s locale and time zone.</div>
									</td>
								</tr>
							
								<tr
									 class='item11'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#formatNumber">formatNumber</a></b>(number, pattern)
										</div>
										<div class="description">Formats a number according to a pattern and the site’s locale setting.</div>
									</td>
								</tr>
							
								<tr
									 class='item12'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#getLocale">getLocale</a></b>(language)
										</div>
										<div class="description">Retrieves the locale object from a language string.</div>
									</td>
								</tr>
							
								<tr
									 class='item13'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#getLocales">getLocales</a></b>(language)
										</div>
										<div class="description">Creates an array of all available Java locales sorted by their names.</div>
									</td>
								</tr>
							
								<tr
									 class='item14'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#gettext_macro">gettext_macro</a></b>(param, text)
										</div>
										<div class="description">Helma macro wrapper for the gettext() method.</div>
									</td>
								</tr>
							
								<tr
									 class='item15'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#getTimeZones">getTimeZones</a></b>(language)
										</div>
										<div class="description">This method returns an array of structs providing two properties each:
<code>value</code> – a unique time zone ID
<code>display</code> – a (more) user-friendly string
Although Java is great in providing all time zones one can imagine, this
vast amount of choices fails to support easy time zone selection.</div>
									</td>
								</tr>
							
								<tr
									 class='item16'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#idle">idle</a></b>()
										</div>
										<div class="description">Shortcut for a function with empty body.</div>
									</td>
								</tr>
							
								<tr
									 class='item17'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#if_macro">if_macro</a></b>(param, firstValue, _is_, secondValue, _then_, firstResult, _else_, secondResult)
										</div>
										<div class="description">Renders a string depending on the comparison of two values.</div>
									</td>
								</tr>
							
								<tr
									 class='item18'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#image_macro">image_macro</a></b>(param, id, mode)
										</div>
										<div class="description">Renders the URL, a thumbnail or an HTML element of an image.</div>
									</td>
								</tr>
							
								<tr
									 class='item19'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#injectXslDeclaration">injectXslDeclaration</a></b>(xml)
										</div>
										<div class="description">Injects the XSLT stylesheet declaration into an XML string until Mozilla developers will have mercy.</div>
									</td>
								</tr>
							
								<tr
									 class='item20'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#link_filter">link_filter</a></b>(text, param, url)
										</div>
										<div class="description">Helma macro filter wrapping the <a href="../symbols/_global_.html#renderLink">renderLink</a> method.</div>
									</td>
								</tr>
							
								<tr
									 class='item21'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#link_macro">link_macro</a></b>()
										</div>
										<div class="description">Renders a link.</div>
									</td>
								</tr>
							
								<tr
									 class='item22'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#list_macro">list_macro</a></b>(param, id, limit)
										</div>
										<div class="description">The “swiss army knife” list macro.</div>
									</td>
								</tr>
							
								<tr
									 class='item23'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#listItemFlag_macro">listItemFlag_macro</a></b>(param, str)
										</div>
										<div class="description">Renders a string vertically in the global listItemFlag skin.</div>
									</td>
								</tr>
							
								<tr
									 class='item24'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#markgettext_macro">markgettext_macro</a></b>(param, singular, plural)
										</div>
										<div class="description">Helma macro wrapper for the markgettext() method.</div>
									</td>
								</tr>
							
								<tr
									 class='item25'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#ngettext_macro">ngettext_macro</a></b>(param, singular, plural)
										</div>
										<div class="description">Helma macro wrapper for the ngettext() method.</div>
									</td>
								</tr>
							
								<tr
									 class='item26'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#nightly">nightly</a></b>()
										</div>
										<div class="description">The nightly scheduler.</div>
									</td>
								</tr>
							
								<tr
									 class='item27'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#now_macro">now_macro</a></b>(param, format)
										</div>
										<div class="description">Renders the current date and time.</div>
									</td>
								</tr>
							
								<tr
									 class='item28'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#onStart">onStart</a></b>()
										</div>
										<div class="description">The startup handler Helma is calling automatically shortly after the application has started.</div>
									</td>
								</tr>
							
								<tr
									 class='item29'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#onStop">onStop</a></b>()
										</div>
										<div class="description">This handler is called by Helma automatically before the application is stopped.</div>
									</td>
								</tr>
							
								<tr
									 class='item30'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#pluralize">pluralize</a></b>(singular)
										</div>
										<div class="description">Transforms an english singular form of a noun into its plural form.</div>
									</td>
								</tr>
							
								<tr
									 class='item31'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#poll_macro">poll_macro</a></b>(param, id, mode)
										</div>
										<div class="description">Renders the URL, a link or the visual representation of a poll.</div>
									</td>
								</tr>
							
								<tr
									 class='item32'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#quote">quote</a></b>(str)
										</div>
										<div class="description">Surrounds a string by programmer quotes (").</div>
									</td>
								</tr>
							
								<tr
									 class='item33'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#random_macro">random_macro</a></b>(param, type, mode)
										</div>
										<div class="description">Renders either a skin or the URL of a random site, story or image.</div>
									</td>
								</tr>
							
								<tr
									 class='item34'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#renderLink">renderLink</a></b>(param, url, text, handler)
										</div>
										<div class="description">Renders an HTML <a> element from a URL or HopObject.</div>
									</td>
								</tr>
							
								<tr
									 class='item35'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#renderList">renderList</a></b>(collection, funcOrSkin, itemsPerPage, pageIdx)
										</div>
										<div class="description">Renders an HTML list from a HopObject collection or an array.</div>
									</td>
								</tr>
							
								<tr
									 class='item36'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#renderPager">renderPager</a></b>(collectionOrSize, url, itemsPerPage, pageIdx)
										</div>
										<div class="description">Renders the page navigation for a collection of HopObjects.</div>
									</td>
								</tr>
							
								<tr
									 class='item37'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#scheduler">scheduler</a></b>()
										</div>
										<div class="description">Helma’s built-in main scheduler function.</div>
									</td>
								</tr>
							
								<tr
									 class='item38'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#sendMail">sendMail</a></b>(recipient, subject, body, options)
										</div>
										<div class="description">General mail sending function.</div>
									</td>
								</tr>
							
								<tr
									 class='item39'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#singularize">singularize</a></b>(plural)
										</div>
										<div class="description">Transforms an english plural form of a noun into its singular form.</div>
									</td>
								</tr>
							
								<tr
									 class='item40'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#skin_macro">skin_macro</a></b>(param, name)
										</div>
										<div class="description">Renders a skin from within a skin.</div>
									</td>
								</tr>
							
								<tr
									 class='item41'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#story_macro">story_macro</a></b>(param, id, mode)
										</div>
										<div class="description">Renders the URL of, a link to or an arbitrary skin of a story.</div>
									</td>
								</tr>
							
								<tr
									 class='item42'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#user_macro">user_macro</a></b>()
										</div>
										<div class="description">Helper macro for checking if a user session is authenticated (logged in).</div>
									</td>
								</tr>
							
								<tr
									 class='item43'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#validateEmail">validateEmail</a></b>(str)
										</div>
										<div class="description">Validates if a string is suitable for e-mail messaging.</div>
									</td>
								</tr>
							
								<tr
									 class='item44'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#validateUrl">validateUrl</a></b>(str)
										</div>
										<div class="description">Validates if a string is suitable for requesting a URL.</div>
									</td>
								</tr>
							
								<tr
									 class='item45'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#value_macro">value_macro</a></b>(param, name, value)
										</div>
										<div class="description">Defines and renders a value.</div>
									</td>
								</tr>
							
								<tr
									 class='item46'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#version_macro">version_macro</a></b>(param, type)
										</div>
										<div class="description">Renders the Antville version string.</div>
									</td>
								</tr>
							
								<tr
									 class='item47'
								>
									<td class="attributes">&nbsp;</td>
									<td class="nameDescription">
										<div class="fixedFont"><b><a href="../symbols/_global_.html#wait">wait</a></b>(millis)
										</div>
										<div class="description">Halts the execution of the thread for the specified amount of milliseconds.</div>
									</td>
								</tr>
							
						</tbody>
					</table>
				
			
				
			</div>
		
		
<!--
#### EVENTS SUMMARY
-->
		
<!--
#### CONSTRUCTOR DETAILS
-->
		
<!--
#### FIELD DETAILS
-->
		
			<div class="details props">
				<div class="innerProps">
					<h2 class="sectionTitle">
						Field Detail
					</h2>
					
					
						<div class="fixedFont heading" id="html">
							<span class='lighter'>
							
							</span>
							
							<span class="light">{helma.Html}</span>
							
							<b>html</b>							
						</div>
						
						<div class="description">
							An instance of Helma’s HTML rendering module.
							
								<br />
								<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
							
							
							
						</div>
						
						
							
						
						<div class="hr"></div>
					
						<div class="fixedFont heading" id="lessParser">
							<span class='lighter'>
							
							</span>
							
							<span class="light">{less.Parser}</span>
							
							<b>lessParser</b>							
						</div>
						
						<div class="description">
							An instance of the LESS parser.
							
								<br />
								<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
							
							
							
						</div>
						
						
							
						
						<div class="hr"></div>
					
						<div class="fixedFont heading" id="NAMEPATTERN">
							<span class='lighter'>
							&lt;constant&gt; 
							</span>
							
							<span class="light">{RegExp}</span>
							
							<b>NAMEPATTERN</b>							
						</div>
						
						<div class="description">
							Regular Expression according to Jala’s HopObject.getAccessName().
							
								<br />
								<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
							
							
							
						</div>
						
						
							
						
						<div class="hr"></div>
					
						<div class="fixedFont heading" id="rome">
							<span class='lighter'>
							
							</span>
							
							<span class="light">{Object}</span>
							
							<b>rome</b>							
						</div>
						
						<div class="description">
							A collection of Java classes and namespaces required for parsing and generating RSS.
							
								<br />
								<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
							
							
							
						</div>
						
						
							
						
						<div class="hr"></div>
					
						<div class="fixedFont heading" id="SQLDATEFORMAT">
							<span class='lighter'>
							&lt;constant&gt; 
							</span>
							
							<span class="light">{String}</span>
							
							<b>SQLDATEFORMAT</b>							
						</div>
						
						<div class="description">
							The date format used in SQL queries and commands.
							
								<br />
								<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
							
							
							
						</div>
						
						
							
						
						
					
				</div>
			</div>
		
<!--
#### METHOD DETAILS
-->		
		
			<div class="details props">
				<div class="innerProps">
					<h2 class="sectionTitle">
						Method Detail
					</h2>
					
					<ul class="methodDetail" id="MethodDetail">
						
						
							<li 
								 class='item0'
							>
								<div class="fixedFont heading" id="age_filter">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>age_filter</b>(value, param)
								</div>
								
								<div class="description">
									Helma macro filter wrapping the Date#getAge method.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Date}</span> <b>value</b>
												
											</dt>
											<dd>The original date.</dd>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The resulting age string of the original date.</dd>
											
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd>Date#getAge</dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item1'
							>
								<div class="fixedFont heading" id="breadcrumbs_macro">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>breadcrumbs_macro</b>(param, delimiter)
								</div>
								
								<div class="description">
									Renders a breadcrumbs navigation from the current HopObject path.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>delimiter</b>
												<i>Optional, Default: ' : '</i>
											</dt>
											<dd>The string visually separating two navigation items</dd>
										
									</dl>
								
								
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item2'
							>
								<div class="fixedFont heading" id="cgettext">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>cgettext</b>(key, context)
								</div>
								
								<div class="description">
									This method is useful for disambiguation of messages (single words most of the time) that have different meanings depending on the context. Example: comment – the verb "to comment" vs the noun "a comment".
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_i18n.js.html">i18n.js</a>.
									
									
									
								</div>
								
								
									
										<pre class="code">cgettext('comment', 'verb')</pre>
									
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>key</b>
												
											</dt>
											<dd>The message ID.</dd>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>context</b>
												
											</dt>
											<dd>The context of the message.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> </dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item3'
							>
								<div class="fixedFont heading" id="clip_filter">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>clip_filter</b>(input, param, limit, clipping, delimiter)
								</div>
								
								<div class="description">
									Macro filter for clipping output.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>input</b>
												
											</dt>
											<dd>The original input.</dd>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object.</dd>
										
											<dt>
												<span class="light fixedFont">{Number}</span> <b>limit</b>
												<i>Optional, Default:  20</i>
											</dt>
											<dd>The maximum amount of text parts to be displayed.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>clipping</b>
												<i>Optional, Default:  '...'</i>
											</dt>
											<dd>The replacement for the clipped portions of the text.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>delimiter</b>
												<i>Optional, Default:  '\\s'</i>
											</dt>
											<dd>The regular expression string used to split the text into parts.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The clipped result.</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item4'
							>
								<div class="fixedFont heading" id="default_filter">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{Object}</span>
									
									<b>default_filter</b>(value, param, defaultValue)
								</div>
								
								<div class="description">
									A simple Helma macro filter returning one of two possible values depending on which one is truthy.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>value</b>
												
											</dt>
											<dd>The original (desired) value.</dd>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object.</dd>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>defaultValue</b>
												
											</dt>
											<dd>The fallback value for use if the original value should be untruthy.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{Object}</span> The value argument if truthy, the defaultValue argument otherwise.</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item5'
							>
								<div class="fixedFont heading" id="defineConstants">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{Function}</span>
									
									<b>defineConstants</b>(ctor)
								</div>
								
								<div class="description">
									Helper method to simultaneously define constants and a corresponding array of localized display names.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{<a href="../symbols/HopObject.html">HopObject</a>}</span> <b>ctor</b>
												
											</dt>
											<dd>The desired prototype constructor the constants should be defined for.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{Function}</span> </dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item6'
							>
								<div class="fixedFont heading" id="disableMacro">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{Function}</span>
									
									<b>disableMacro</b>(ctor, name)
								</div>
								
								<div class="description">
									Disables a macro with the idle() function.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{<a href="../symbols/HopObject.html">HopObject</a>}</span> <b>ctor</b>
												
											</dt>
											<dd>The prototype constructor the macro is defined for</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>name</b>
												
											</dt>
											<dd>The macro’s name</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{Function}</span> </dd>
											
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd><a href="../symbols/_global_.html#idle">idle</a></dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item7'
							>
								<div class="fixedFont heading" id="file_macro">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>file_macro</b>(param, id, mode)
								</div>
								
								<div class="description">
									Renders the URL or an arbitrary skin of a file.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
									
										<pre class="code"><% file 1810 url %> URL of file #1810
<% file blog/text.pdf skin=preview %> File in site “blog” using preview skin
<% file /image.raw %> Static file of root site</pre>
									
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>param.skin</b>
												<i>Optional, Default: 'main'</i>
											</dt>
											<dd>The name of a file skin</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>id</b>
												
											</dt>
											<dd>The id or path of the desired file</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>mode</b>
												<i>Optional</i>
											</dt>
											<dd>Currently only possible value is 'url'</dd>
										
									</dl>
								
								
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item8'
							>
								<div class="fixedFont heading" id="fixRssText">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>fixRssText</b>(rss)
								</div>
								
								<div class="description">
									Replaces <img> elements in a string with <a> elements to fix RSS output which is not capable of displaying images.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>rss</b>
												
											</dt>
											<dd>The original RSS output.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The transformed RSS output.</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item9'
							>
								<div class="fixedFont heading" id="format_filter">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>format_filter</b>(value, param, pattern, type)
								</div>
								
								<div class="description">
									Helma macro filter wrapping the global formatting methods.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>value</b>
												
											</dt>
											<dd>The original value.</dd>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>pattern</b>
												
											</dt>
											<dd>A formatting pattern suitable for the formatting method.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>type</b>
												<i>Optional</i>
											</dt>
											<dd>Deprecated.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The formatted string.</dd>
											
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd><a href="../symbols/_global_.html#formatNumber">formatNumber</a></dd>
											
												<dd><a href="../symbols/_global_.html#formatDate">formatDate</a></dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item10'
							>
								<div class="fixedFont heading" id="formatDate">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>formatDate</b>(date, format)
								</div>
								
								<div class="description">
									Formats a date according to a formatting string and the site’s locale and time zone.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Date}</span> <b>date</b>
												
											</dt>
											<dd>The original date.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>format</b>
												<i>Optional, Default:  "full"</i>
											</dt>
											<dd>The formatting string. Either a Java SimpleDateFormat pattern//docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html or of “short”, “medium”, “long”, “full”, “date”, “time”, “iso” or “text”.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The formatted date string.</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item11'
							>
								<div class="fixedFont heading" id="formatNumber">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>formatNumber</b>(number, pattern)
								</div>
								
								<div class="description">
									Formats a number according to a pattern and the site’s locale setting.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Number}</span> <b>number</b>
												
											</dt>
											<dd>The original number.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>pattern</b>
												
											</dt>
											<dd>The formatting pattern.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The formatted number string.</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item12'
							>
								<div class="fixedFont heading" id="getLocale">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{java.util.Locale}</span>
									
									<b>getLocale</b>(language)
								</div>
								
								<div class="description">
									Retrieves the locale object from a language string.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>language</b>
												
											</dt>
											<dd>The name of the language.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{java.util.Locale}</span> The corresponding locale object.</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item13'
							>
								<div class="fixedFont heading" id="getLocales">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{Object[]}</span>
									
									<b>getLocales</b>(language)
								</div>
								
								<div class="description">
									Creates an array of all available Java locales sorted by their names.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>language</b>
												
											</dt>
											<dd>The optional language of the locales</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{Object[]}</span> A sorted array containing the corresponding locales</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item14'
							>
								<div class="fixedFont heading" id="gettext_macro">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>gettext_macro</b>(param, text)
								</div>
								
								<div class="description">
									Helma macro wrapper for the gettext() method.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_i18n.js.html">i18n.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>text</b>
												
											</dt>
											<dd>The text used as message ID.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> Either the translated or the original text.</dd>
											
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd>jala.i18n.gettext</dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item15'
							>
								<div class="fixedFont heading" id="getTimeZones">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{Object[]}</span>
									
									<b>getTimeZones</b>(language)
								</div>
								
								<div class="description">
									This method returns an array of structs providing two properties each:
<code>value</code> – a unique time zone ID
<code>display</code> – a (more) user-friendly string
Although Java is great in providing all time zones one can imagine, this
vast amount of choices fails to support easy time zone selection.
Furthermore, the L10n features of the java.util.TimeZone class are insufficient
as they do only translate the generic string returned by the getDisplayName()
method (e.g. Central European Time), not the more usable time zone IDs 
(e.g. Europe/Vienna). Thus, time zone selection in Antville is rather limited.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>language</b>
												
											</dt>
											<dd></dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{Object[]}</span> A sorted array containing the corresponding timezones</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item16'
							>
								<div class="fixedFont heading" id="idle">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>idle</b>()
								</div>
								
								<div class="description">
									Shortcut for a function with empty body.
Used e.g. in the disableMacro() method.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd><a href="../symbols/_global_.html#disableMacro">disableMacro</a></dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item17'
							>
								<div class="fixedFont heading" id="if_macro">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>if_macro</b>(param, firstValue, _is_, secondValue, _then_, firstResult, _else_, secondResult)
								</div>
								
								<div class="description">
									Renders a string depending on the comparison of two values. 
If the first value equals the second value, the first result will be returned; the second result otherwise.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
									
										<pre class="code"><% if <% macro %> is value then <% yes suffix=! %> else 'no :(' %>;
Note that any value or result can be a macro, too. Thus, this can be used as
a simple implementation of an if-then-else statement by using Helma macros only.</pre>
									
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>firstValue</b>
												
											</dt>
											<dd>The first value</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>_is_</b>
												
											</dt>
											<dd>Syntactic sugar; should be "is" for legibility</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>secondValue</b>
												
											</dt>
											<dd>The second value</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>_then_</b>
												
											</dt>
											<dd>Syntactic sugar; should be "then" for legibility</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>firstResult</b>
												
											</dt>
											<dd>The first result, ie. the value that will be 
returned if the first value equals the second one</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>_else_</b>
												
											</dt>
											<dd>Syntactic sugar; should be "else" for legibility</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>secondResult</b>
												
											</dt>
											<dd>The second result, ie. the value that will be 
returned if the first value does not equal the second one</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The resulting value</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item18'
							>
								<div class="fixedFont heading" id="image_macro">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>image_macro</b>(param, id, mode)
								</div>
								
								<div class="description">
									Renders the URL, a thumbnail or an HTML element of an image.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>id</b>
												
											</dt>
											<dd>The id or path of the desired image</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>mode</b>
												<i>Optional</i>
											</dt>
											<dd>Either of 'url' or 'thumbnail'</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd><a href="../symbols/Image.html#thumbnail_macro">Image#thumbnail_macro</a></dd>
											
												<dd><a href="../symbols/Image.html#render_macro">Image#render_macro</a></dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item19'
							>
								<div class="fixedFont heading" id="injectXslDeclaration">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>injectXslDeclaration</b>(xml)
								</div>
								
								<div class="description">
									Injects the XSLT stylesheet declaration into an XML string until Mozilla developers will have mercy.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>xml</b>
												
											</dt>
											<dd>An XML string</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> An XML string containing the XSLT stylesheet declaration</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item20'
							>
								<div class="fixedFont heading" id="link_filter">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>link_filter</b>(text, param, url)
								</div>
								
								<div class="description">
									Helma macro filter wrapping the <a href="../symbols/_global_.html#renderLink">renderLink</a> method.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>text</b>
												
											</dt>
											<dd>The link text.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object.</dd>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>url</b>
												<i>Optional, Default:  text</i>
											</dt>
											<dd>The link URL.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The rendered link element</dd>
											
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd><a href="../symbols/_global_.html#renderLink">renderLink</a></dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item21'
							>
								<div class="fixedFont heading" id="link_macro">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>link_macro</b>()
								</div>
								
								<div class="description">
									Renders a link.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The rendered HTML link element</dd>
											
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd><a href="../symbols/_global_.html#renderLink">renderLink</a></dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item22'
							>
								<div class="fixedFont heading" id="list_macro">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>list_macro</b>(param, id, limit)
								</div>
								
								<div class="description">
									The “swiss army knife” list macro. Lists collections of HopObjects.
There is hardly a thing it cannot do… but it’s kind of messy, though.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
									
										<pre class="code"><% list sites %>
<% list updates 10 %>
<% list blog/comments %>
<% list featured skin=promotion %>
<% list images %>
<% list postings %>
<% list stories %>
<% list tags %></pre>
									
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>param.skin</b>
												<i>Optional, Default: preview</i>
											</dt>
											<dd>The name of a skin suitable for the collection</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>id</b>
												
											</dt>
											<dd>The identifier of the desired collection</dd>
										
											<dt>
												<span class="light fixedFont">{Number}</span> <b>limit</b>
												<i>Optional, Default: 25</i>
											</dt>
											<dd>The maximum amount of items listed</dd>
										
									</dl>
								
								
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item23'
							>
								<div class="fixedFont heading" id="listItemFlag_macro">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>listItemFlag_macro</b>(param, str)
								</div>
								
								<div class="description">
									Renders a string vertically in the global listItemFlag skin.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>str</b>
												
											</dt>
											<dd>The string to be rendered.</dd>
										
									</dl>
								
								
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item24'
							>
								<div class="fixedFont heading" id="markgettext_macro">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>markgettext_macro</b>(param, singular, plural)
								</div>
								
								<div class="description">
									Helma macro wrapper for the markgettext() method.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_i18n.js.html">i18n.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object.</dd>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>singular</b>
												
											</dt>
											<dd>The text used as the singular message ID.</dd>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>plural</b>
												
											</dt>
											<dd>The text used as the plural message ID.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd>jala.i18n.markgettext</dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item25'
							>
								<div class="fixedFont heading" id="ngettext_macro">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>ngettext_macro</b>(param, singular, plural)
								</div>
								
								<div class="description">
									Helma macro wrapper for the ngettext() method.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_i18n.js.html">i18n.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>singular</b>
												
											</dt>
											<dd>The text used as the singular message ID.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>plural</b>
												
											</dt>
											<dd>The text used as the plural message ID.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd>String Either the translated or the original string.</dd>
											
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd>jala.i18n.ngettext</dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item26'
							>
								<div class="fixedFont heading" id="nightly">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>nightly</b>()
								</div>
								
								<div class="description">
									The nightly scheduler. 
This method is called according to the cron settings in app.properties.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
								
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item27'
							>
								<div class="fixedFont heading" id="now_macro">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>now_macro</b>(param, format)
								</div>
								
								<div class="description">
									Renders the current date and time.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>format</b>
												<i>Optional</i>
											</dt>
											<dd>A date format string</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The formatted current date string</dd>
											
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd><a href="../symbols/_global_.html#formatDate">formatDate</a></dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item28'
							>
								<div class="fixedFont heading" id="onStart">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>onStart</b>()
								</div>
								
								<div class="description">
									The startup handler Helma is calling automatically shortly after the application has started.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
								
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item29'
							>
								<div class="fixedFont heading" id="onStop">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>onStop</b>()
								</div>
								
								<div class="description">
									This handler is called by Helma automatically before the application is stopped.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
								
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item30'
							>
								<div class="fixedFont heading" id="pluralize">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>pluralize</b>(singular)
								</div>
								
								<div class="description">
									Transforms an english singular form of a noun into its plural form.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>singular</b>
												
											</dt>
											<dd>The noun in singular form.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The english plural form of the original input.</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item31'
							>
								<div class="fixedFont heading" id="poll_macro">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>poll_macro</b>(param, id, mode)
								</div>
								
								<div class="description">
									Renders the URL, a link or the visual representation of a poll.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>id</b>
												
											</dt>
											<dd>The id or path of the desired poll</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>mode</b>
												
											</dt>
											<dd>Either of 'url' or 'link'</dd>
										
									</dl>
								
								
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item32'
							>
								<div class="fixedFont heading" id="quote">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>quote</b>(str)
								</div>
								
								<div class="description">
									Surrounds a string by programmer quotes (").
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>str</b>
												
											</dt>
											<dd>The original string.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The processed string.</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item33'
							>
								<div class="fixedFont heading" id="random_macro">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>random_macro</b>(param, type, mode)
								</div>
								
								<div class="description">
									Renders either a skin or the URL of a random site, story or image.
The corresponding story and image collections will be retrieved either from res.handlers.site or 
from the prefixed “type” argument (e.g. “mySite/story”).
Furthermore, both collections can be reduced to a specific tag or gallery, resp.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
									
										<pre class="code"><% random site skin=preview %> Renders the preview skin of a random site.
<% random story tag=essay url %> Renders the URL of a random story tagged with “essay”.
<% random foo/image gallery=cat %> Renders the default skin of a random image in the gallery “cat“ of the site “foo”.</pre>
									
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>param.skin</b>
												<i>Optional, Default:  "preview"</i>
											</dt>
											<dd>The name of the skin to render in default output mode.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>param.tag</b>
												<i>Optional</i>
											</dt>
											<dd>Reduce the story collection to stories with the specified tag.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>param.gallery</b>
												<i>Optional</i>
											</dt>
											<dd>Reduce the image collection to images from the specified gallery.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>type</b>
												
											</dt>
											<dd>The type of object to render. Either of “site”, “story” or “image”.
It can be prepended by a site name delimited by a slash: “mySite/image”.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>mode</b>
												<i>Optional</i>
											</dt>
											<dd>Set the output mode. Currently, only “url” is supported.</dd>
										
									</dl>
								
								
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item34'
							>
								<div class="fixedFont heading" id="renderLink">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>renderLink</b>(param, url, text, handler)
								</div>
								
								<div class="description">
									Renders an HTML <a> element from a URL or HopObject.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>param.title</b>
												<i>Optional</i>
											</dt>
											<dd>An optional link title for use in the “title” attribute.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>url</b>
												
											</dt>
											<dd>A complete or partial URL string. Optional if “handler” is specified.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>text</b>
												<i>Optional</i>
											</dt>
											<dd>An optional link text.</dd>
										
											<dt>
												<span class="light fixedFont">{<a href="../symbols/HopObject.html">HopObject</a>}</span> <b>handler</b>
												
											</dt>
											<dd>The HopObject used as base URL. Optional if “url” is specified.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd>helma.Html#link</dd>
											
												<dd><a href="../symbols/HopObject.html#link_macro">HopObject#link_macro</a></dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item35'
							>
								<div class="fixedFont heading" id="renderList">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>renderList</b>(collection, funcOrSkin, itemsPerPage, pageIdx)
								</div>
								
								<div class="description">
									Renders an HTML list from a HopObject collection or an array.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{<a href="../symbols/HopObject.html">HopObject</a>|Array}</span> <b>collection</b>
												
											</dt>
											<dd>The original collection of objects.</dd>
										
											<dt>
												<span class="light fixedFont">{Function|<a href="../symbols/Skin.html">Skin</a>}</span> <b>funcOrSkin</b>
												
											</dt>
											<dd>A skin name or a rendering function.</dd>
										
											<dt>
												<span class="light fixedFont">{Number}</span> <b>itemsPerPage</b>
												
											</dt>
											<dd>The amount of rendered items per page.</dd>
										
											<dt>
												<span class="light fixedFont">{Number}</span> <b>pageIdx</b>
												
											</dt>
											<dd>The current page index.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The rendered list.</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item36'
							>
								<div class="fixedFont heading" id="renderPager">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>renderPager</b>(collectionOrSize, url, itemsPerPage, pageIdx)
								</div>
								
								<div class="description">
									Renders the page navigation for a collection of HopObjects.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{<a href="../symbols/HopObject.html">HopObject</a>|Array|Number}</span> <b>collectionOrSize</b>
												
											</dt>
											<dd>A collection or just the size of a collection.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>url</b>
												
											</dt>
											<dd>The base URL for rendering links.</dd>
										
											<dt>
												<span class="light fixedFont">{Number}</span> <b>itemsPerPage</b>
												
											</dt>
											<dd>The amount of rendered items per page.</dd>
										
											<dt>
												<span class="light fixedFont">{Number}</span> <b>pageIdx</b>
												
											</dt>
											<dd>The current page index.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The rendered page navigation.</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item37'
							>
								<div class="fixedFont heading" id="scheduler">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{Number}</span>
									
									<b>scheduler</b>()
								</div>
								
								<div class="description">
									Helma’s built-in main scheduler function.
This method is regularly called by Helma after a defined period of time.
The period is either defined by the return value or by the schedulerInterval property in app.properties.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{Number}</span> The period in milliseconds the scheduler will be called again.</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item38'
							>
								<div class="fixedFont heading" id="sendMail">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{Number}</span>
									
									<b>sendMail</b>(recipient, subject, body, options)
								</div>
								
								<div class="description">
									General mail sending function. Mails will be queued in app.data.mails.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>recipient</b>
												
											</dt>
											<dd>The recipient's email addresses</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>subject</b>
												
											</dt>
											<dd>The e-mail's subject</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>body</b>
												
											</dt>
											<dd>The body text of the e-mail</dd>
										
											<dt>
												<b>options</b>
												
											</dt>
											<dd></dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{Number}</span> The status code of the underlying helma.Mail instance</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item39'
							>
								<div class="fixedFont heading" id="singularize">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>singularize</b>(plural)
								</div>
								
								<div class="description">
									Transforms an english plural form of a noun into its singular form.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>plural</b>
												
											</dt>
											<dd>The noun in plural form.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The english singular form of the original input.</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item40'
							>
								<div class="fixedFont heading" id="skin_macro">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String}</span>
									
									<b>skin_macro</b>(param, name)
								</div>
								
								<div class="description">
									Renders a skin from within a skin.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<b>param</b>
												
											</dt>
											<dd></dd>
										
											<dt>
												<b>name</b>
												
											</dt>
											<dd></dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String}</span> The rendered skin</dd>
											
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd><a href="../symbols/HopObject.html#skin_macro">HopObject#skin_macro</a></dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item41'
							>
								<div class="fixedFont heading" id="story_macro">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>story_macro</b>(param, id, mode)
								</div>
								
								<div class="description">
									Renders the URL of, a link to or an arbitrary skin of a story.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
									
										<pre class="code"><% story 1810 skin=preview %> Story #1810 in preview skin
<% story blog/1971 url %> URL of the story of site “blog”</pre>
									
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>param.skin</b>
												<i>Optional, Default: 'embed'</i>
											</dt>
											<dd>The name of a story skin</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>id</b>
												
											</dt>
											<dd>The id or path of the desired story</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>mode</b>
												<i>Optional</i>
											</dt>
											<dd>Either of 'url' or 'link'</dd>
										
									</dl>
								
								
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item42'
							>
								<div class="fixedFont heading" id="user_macro">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{Boolean}</span>
									
									<b>user_macro</b>()
								</div>
								
								<div class="description">
									Helper macro for checking if a user session is authenticated (logged in).
Returns true if user is logged in, false otherwise.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{Boolean}</span> </dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item43'
							>
								<div class="fixedFont heading" id="validateEmail">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String|null}</span>
									
									<b>validateEmail</b>(str)
								</div>
								
								<div class="description">
									Validates if a string is suitable for e-mail messaging.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>str</b>
												
											</dt>
											<dd>The string to be validated.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String|null}</span> The e-mail string if valid, null otherwise.</dd>
											
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd>String#isEmail</dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item44'
							>
								<div class="fixedFont heading" id="validateUrl">
									<span class='lighter'>
									
									</span>
									
									<span class="light">{String|null}</span>
									
									<b>validateUrl</b>(str)
								</div>
								
								<div class="description">
									Validates if a string is suitable for requesting a URL.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>str</b>
												
											</dt>
											<dd>The string to be validated.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
											<dt class="heading">Returns:</dt>
											
												<dd><span class="light fixedFont">{String|null}</span> The URL string if valid, null otherwise.</dd>
											
										
										
										
										
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item45'
							>
								<div class="fixedFont heading" id="value_macro">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>value_macro</b>(param, name, value)
								</div>
								
								<div class="description">
									Defines and renders a value.
This works like a variable that can be set in one skin and rendered in another –
which must be rendered later than the one setting the variable.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
									
										<pre class="code"><% value foo=bar %> Defines res.meta.values.foo = bar</pre>
									
										<pre class="code"><% value foo %> Renders the value of res.meta.value.foo</pre>
									
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>name</b>
												
											</dt>
											<dd>The name of the value.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>value</b>
												<i>Optional</i>
											</dt>
											<dd>The desired value. 
If no value is given, the current value will be rendered.</dd>
										
									</dl>
								
								
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item46'
							>
								<div class="fixedFont heading" id="version_macro">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>version_macro</b>(param, type)
								</div>
								
								<div class="description">
									Renders the Antville version string.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Object}</span> <b>param</b>
												
											</dt>
											<dd>The default Helma macro parameter object.</dd>
										
											<dt>
												<span class="light fixedFont">{String}</span> <b>type</b>
												<i>Optional, Default:  'default'</i>
											</dt>
											<dd>The type of version string.</dd>
										
									</dl>
								
								
								
									<dl class="detailList nomargin">
									
										
										
										
										
										
										
										
										
										
										
										
											<dt class="heading">See:</dt>
											
												<dd><a href="../symbols/Root.html#.VERSION">Root.VERSION</a></dd>
											
										
									
									</dl>
								
								<div class="hr"></div>
							</li>
						
							<li 
								 class='item47'
							>
								<div class="fixedFont heading" id="wait">
									<span class='lighter'>
									
									</span>
									
									
									
									<b>wait</b>(millis)
								</div>
								
								<div class="description">
									Halts the execution of the thread for the specified amount of milliseconds.
Use only for debugging.
									
									
										<br />
										<i>Defined in: </i> <a href="../symbols/src/_Users_tobi_Projects_helma_apps_antville_code_Global_Global.js.html">Global.js</a>.
									
									
									
								</div>
								
								
								
								
									<dl class="detailList params">
										<dt class="heading">Parameters:</dt>
										
											<dt>
												<span class="light fixedFont">{Number}</span> <b>millis</b>
												
											</dt>
											<dd>The amount of milliseconds.</dd>
										
									</dl>
								
								
								
								
							</li>
						
					</ul>
				</div>
			</div>
		
		
<!--
#### EVENT DETAILS
-->		
		
	</div>
</div>
		<script type="text/javascript">
			wbos.CssTools.MediaQueryFallBack.LoadCss('../css/screen.css', '../css/handheld.css', 660)
			codeview.classFilter.Init()
		</script>
	</body>
</html>

